home *** CD-ROM | disk | FTP | other *** search
/ The Atari Compendium / The Atari Compendium (Toad Computers) (1994).iso / files / umich / utils / nroff~06.zoo / doc.zoo / nroff.1 < prev    next >
Text File  |  1992-07-17  |  44KB  |  1,060 lines
  1.  
  2. NAME
  3.     nroff - text processor (Version 1.10p5)
  4.  
  5. SYNOPSIS
  6.     nroff [ options ] file [...]
  7.  
  8. DESCRIPTION
  9.     Nroff  is  a  text  processor  and formatter based on the design
  10.     provided in "Software Tools" by Kernighan and Plauger.   It  has
  11.     been modified  to closely resemble the Unix™ nroff command.  The
  12.     text and commands found in the file(s) are processed to generate
  13.     formatted text.  Note that one (and only one) of the  files  can
  14.     be "-"  which reads input from stdin at that point.  If no files
  15.     are specified, stdin is read so that nroff can act as a  filter.
  16.     The  output always goes to stdout which can be redirected by the
  17.     shell.  The -e option lets you  redirect  error  output  to  the
  18.     specified file  rather than stderr.  Output from the .tm command
  19.     also goes to stderr.  Debugging information always goes  to  the
  20.     file   "nroff.dbg"  and  is  generally  used  only  for  program
  21.     development.
  22.  
  23. OPTIONS
  24.     The following command line options are available:
  25.  
  26.     -Tname
  27.         Use table for name to  generate  proper  characters  for
  28.         device  name. Currently, nroff only generates ANSI/vt100
  29.         escapes for font changes (\fB, etc) internally (does not
  30.         read tabname).  View results with manpager(1).
  31.  
  32.     -d
  33.         Set debug mode.  Debug output to stderr (or  error  log,
  34.         if -e comes first on the command line).
  35.  
  36.     -debug
  37.         Set debug mode.  Debug output goes to file nroff.dbg.
  38.  
  39.     -efile
  40.         Set error log file (default is stderr).
  41.  
  42.     -h
  43.         Hold before exit (Atari TOS only).
  44.  
  45.     -help
  46.         Print command synopsis.
  47.  
  48.     -mname
  49.         Process macro file tmac.name.  Thus -man would cause the
  50.         file tmac.an to be loaded.  Note that files processed in
  51.         this  way  should contain only macro definitions, no im-
  52.         mediate output should be generated from this  file  (see
  53.         ENVIRONMENT).
  54.  
  55.     -raN
  56.         Preset   number  register  a  (single  character)  to  N
  57.         (decimal integer only).
  58.  
  59.     -pon
  60.         Shift output right n spaces (like .po).
  61.  
  62.     -pnn
  63.         Initial page number to n (like .pn).
  64.  
  65.     -version
  66.         Prints the version information to stdout.
  67.     +n
  68.         Causes output to start with page n.
  69.  
  70.     -n
  71.         Causes output to stop after page n.
  72.  
  73.     -
  74.         Input from stdin.
  75.  
  76.  
  77. ENVIRONMENT
  78.     Nroff recognizes the following environment  variables  from  the
  79.     shell:
  80.  
  81.     TMACDIR
  82.         An alternate directory to find the files tmac.* ("." for
  83.         example).   The  default  is  c:\lib\tmac  under TOS and
  84.         /usr/lib/tmac under Minix or Unix™.
  85.  
  86.     TMPDIR
  87.         An alternate directory to  place  any  temporary  files.
  88.         The default  is  the current directory.  Note that nroff
  89.         does not currently use any temporary files.
  90.  
  91. COMMANDS
  92.     Commands typically are distinguished by a period in  column  one
  93.     of  the  input  followed by a two character abbreviation for the
  94.     command funtion.  The abbreviation may then be  followed  by  an
  95.     optional numeric  or  character  argument.  The numeric argument
  96.     may be an absolute value such as setting the right margin  to  a
  97.     particular  column,  or  the  argument may be preceded by a plus
  98.     sign or a minus sign to indicate that the  parameter  should  be
  99.     modified relative to a previous setting.  The following commands
  100.     are  recognized  (those marked "extension" are requests added to
  101.     the basic set provided by Unix™ nroff):
  102.  
  103.     .ad
  104.         Begin line adjustment.  If fill  mode  is  not  on,  ad-
  105.         justment is  defered  until  it  is  back on.  If a type
  106.         indicator is present, the adjustment type is changed  as
  107.         follows:
  108.         
  109.              Indicator      Type
  110.                 l           adjust left margin only
  111.                 r           adjust right margin only
  112.                 c           center
  113.              b or n         adjust both margins (default)
  114.              absent         unchanged
  115.  
  116.     .af
  117.         Assign format to number register.  The available formats
  118.         are:
  119.         
  120.              Format    Numbering Sequence
  121.                1       0,1,2,3,4,...
  122.               001      000,001,002,...
  123.                i       0,i,ii,iii,iv,v,...
  124.                I       0,I,II,III,IV,V,...
  125.                a       0,a,b,...,z,aa,ab,...zz,aaa,...
  126.                A       0,A,B,...,Z,AA,AB,...ZZ,AAA,...
  127.         
  128.         The  second format above indicates that the field width,
  129.         i.e.  number of digits, is specified by  the  number  of
  130.         digits in the format type.
  131.  
  132.     .bd
  133.         Ignored by nroff.
  134.  
  135.     .bo (extension)
  136.         Causes   the  following  lines  of  text  to  appear  in
  137.         boldface.  The optional argument specifies the number of
  138.         lines to be typed in boldface.  Boldface and underlining
  139.         are mutually exclusive features.  The  appearance  of  a
  140.         boldface command will cause any underlining to cease.
  141.  
  142.     .bp (extension)
  143.         Causes  succeeding  text  to  appear at the top of a new
  144.         page.  The optional argument specifies the  page  number
  145.         for the  new  page.    The  initial value is one and the
  146.         default  value  is  one  more  than  the  previous  page
  147.         number.
  148.  
  149.     .br
  150.         Causes  succeeding  text  to  start on a new line at the
  151.         current left margin.  There is no numeric  argument  for
  152.         this command.
  153.  
  154.     .bs (extension)
  155.         Enables  or disables the appearance of backspaces in the
  156.         output text.  Underlining and boldface options  are  im-
  157.         plemented by inserting character - backspace - character
  158.         combinations into  the  output buffer.  This is fine for
  159.         devices   which   properly   recognize   the   backspace
  160.         character.   Some  printers,  however,  do not recognize
  161.         backspaces, so the option is provided to  overprint  one
  162.         line buffer  with  another.    The  first line buffer is
  163.         terminated with just a carriage return rather  than  the
  164.         carriage return - linefeed combination.  A zero argument
  165.         or  no  argument  to the backspace command removes back-
  166.         spaces from the output.  A non-zero argument leaves them
  167.         in the output.  The default is to remove backspaces.
  168.  
  169.     .cc
  170.         Changes the nroff command character to that specified by
  171.         the character argument.  If no argument is provided, the
  172.         default is a period (.).
  173.  
  174.     .ce
  175.         Causes the next line of text to appear centered  on  the
  176.         output.   The  optional  argument specifies if more than
  177.         one line is to be centered.
  178.  
  179.     .cs
  180.         Ignored by nroff.
  181.  
  182.     .cu
  183.         Causes the next  line(s)  of  text  to  be  continuously
  184.         underlined.   Unlike  the  underline  command  (see .ul)
  185.         which  underlines  only  alphanumerics,  continuous  un-
  186.         derlining underlines  all  printable  characters.    The
  187.         optional argument specifies the number of lines of  text
  188.         to underlined.   Any normal underlining or boldface com-
  189.         mands currently in effect will be terminated.
  190.  
  191.     .c2
  192.         Changes the nroff no break character to  that  specified
  193.         by the  character argument.  If no argument is provided,
  194.         the default is a single quote.
  195.  
  196.     .de
  197.         Causes all text and commands following  to  be  used  to
  198.         define a  macro.   The definition is terminated by a .en
  199.         command or the default .. terminator.    The  first  two
  200.         characters  of  the  argument  following the .de command
  201.         become the name of the new command.  It should be  noted
  202.         that  upper  and  lower  case  arguments  are considered
  203.         different.  Thus, the commands .PP and .pp could  define
  204.         two different  macros.    Care should be exercised since
  205.         existing commands may be redefined.
  206.  
  207.         A macro may contain up to nine arguments.  In the  macro
  208.         definition,  the placement of arguments is designated by
  209.         the two character sequences, $1, $2, ... $9.   When  the
  210.         macro  is  invoked,  each  argument of the macro command
  211.         line is substituted for its corresponding designator  in
  212.         the expansion.   The first argument of the macro command
  213.         is substituted f